home *** CD-ROM | disk | FTP | other *** search
/ Speccy ClassiX 1998 / Speccy ClassiX 98.iso / amiga_system / the_aminet / comm / bbs / maxsutils.lha / MaxUtils / MaxiText24.lha / Maxi-Text.docs < prev    next >
Text File  |  1993-09-09  |  10KB  |  242 lines
  1.  
  2.        Maxi-Text Version 2.4  by Robert Masters for MAXsBBS 1.52
  3.  
  4.                       KickStart Release 36+ Only !
  5.  
  6. Notes on Version 2.0:
  7.  
  8. Old config files (before version 2.0) are now useless and should be deleted.
  9.  
  10. Old template files will need to be fixed, previous versions loaded a new
  11. name ect. when the name function was called, to fix these, you should
  12. place a '+' function before the name function.
  13.  
  14. All processing in done in memory now, so Maxi-Text will run many times
  15. faster than before. All sorting functions optimized.
  16.  
  17. As of this release differant versions of the program are included for
  18. various processor types.. This was due to tha fact that MaxiText needs
  19. every bit of speed it can get, and was slowing systems doen with it's
  20. processing. Use the following versions for your processor type:
  21.  
  22. 68000 / 68010     : Maxi-Text
  23. 68020 / 68030     : Maxi-Text.020
  24. 68040 / 68060     : Maxi-Text.040 (68040.library must be present)
  25.  
  26. I suggest you look at the new line duplicating functions, these make
  27. template much easier to create and maintain, and by using the duplicate
  28. functions you wil increase parsar speed.
  29.  
  30.  
  31. Maxi-Text works similar to the way you can insert special characters
  32. using the '%' symbol into MAXsBBS text files. This program allows for
  33. more flexability to let you creat your own 'Top Ten' lists or last
  34. users.
  35.  
  36. Maxi-Text, unlike other 'Top Ten' type programs, lets you design the
  37. screen, and by using functions like - ╗(tun:20), you can insert the name
  38. of the top uploader. There are some examples of how to use this program
  39. in the archive. To use the insert functions, read the Maxi-Text.insert
  40. file.
  41.  
  42. Maxi-Text doesn't limit you to just the top ten, you can go as far as a
  43. top thirty in this release. And because Maxi-Text allows you to format
  44. the output, you can specify the size of most of the output strings.
  45.  
  46. You can use this program in a logoff script, or shell, to change any text
  47. template into a 'Top Ten'. With Maxi-Text, you can still use the MAXsBBS
  48. formating commands like '%Z' for a pause, as they will be passed through
  49. the parser. If you run a multi-line bbs, you can choose differant
  50. configurations to use, just from the program arguments.
  51.  
  52.  
  53. *How to use this great program -
  54. ---------------------------------------------------------------------------
  55. Maxi-Text [from] template [to] text-file [[using] config]
  56.  
  57. eg: 
  58.  
  59. Maxi-Text from BBS:Template/TopUser to BBS:Text/TopUser
  60. or
  61. Maxi-Text from BBS:Template/TopUser to BBS:Text/
  62.  
  63. To transform Template/TopUser into Text/TopUser
  64.  
  65. or
  66.  
  67. Maxi-Text BBS:Template/ BBS:Text/
  68.  
  69. To transform all files in BBS:Template/ to BBS:Text/
  70.  
  71.  
  72. The commands in the brackets are optional, here is an explanation of
  73. each argument..
  74.  
  75.  
  76. Template: this is the basic text file with all the functions written in,
  77. it should be designed by you for a custom screen. You may include any
  78. valid text character, ANSI sequence, or MAXsBBS insert command. You may
  79. also put a path name here, and all the text in the path will be scanned
  80. and copied to the second path. If you do use a path, make sure that the
  81. output is also a path.
  82.  
  83. Text-File: this is what will be produced after you run Maxi-Text. You
  84. may enter a directory name here, or any suitable path with an ':' or '/'
  85. extention, and the output file will use the same name as the input. If
  86. if you are using a path for the input, the same name will be used from
  87. the input path.
  88.  
  89. Options-File: If you specify no argument, the default S:Maxi-Text.config
  90. will be used, but if you run on multi-line, or use differant
  91. MAXsBBS.config files, you may wish to specify a differant file. If you
  92. only specify a pathname, 'Maxi-Text.config' will be appended.
  93.  
  94.  
  95.  
  96.  
  97. *Configuration
  98. ---------------------------------------------------------------------------
  99. Before you use Maxi-Text, you must configure it. Use the following
  100. arguments -
  101.  
  102. Maxi-Text -c [from] [input config] [to] [output config]
  103.  
  104. Input Config is the name of the MAXsBBS.config file you are using, if
  105. it's name is simply MAXsBBS.Config, you can leave it blank. If this is
  106. the case, you must leave the next field blank also. If the config uses
  107. the standard MAXsBBS.config file, but is in a differant directory, you
  108. may just use the directory name. If you only specify a pathname,
  109. 'MAXsBBS.Config' will be appended.
  110.  
  111. Output Config is the name of the config file that Maxi-Text uses, if you
  112. run only one line, then you may use the default S:Maxi-Text.config or
  113. leave the field blank. If you only specify a pathname, 'Maxi-Text.config'
  114. will be appended.
  115.  
  116.  
  117. Section and Access Exclusion:
  118.  
  119. You may to have only some access levels included in the list, if this is
  120. the case answer yes, and you will be prompted for a low and high access
  121. level to include. To keep co-sysops and sysops out of the list, enter
  122. 1 to 4999, or to only keep sysops out of the list use 1 to 9999.
  123.  
  124. Users with access 0 (cut-off) are automaticly excluded from the output
  125. lists. The access restrictions do not apply to 'Top Cps', 'Last User' or
  126. 'Top File' because of the overhead required to check.
  127.  
  128. You may exclude upto 20 sections from the output lists from here,
  129. you will be prompted if you want to exclude any sections. If you do,
  130. enter upto 20 sections, or enter 0 when you have finished. This only
  131. applys to the 'Top File' and 'Top Message' lists.
  132.  
  133. Other than checking each user against the user.data, there is no quick
  134. way to check access for 'Last User' or 'Top CPS', if you have a need for
  135. this function, let me know.
  136.  
  137.  
  138. Update Options:
  139.  
  140. You will be asked if you wish to always update the CPS list. Because the
  141. CPS is read from a text file, rather than a data file, it is likly that
  142. you will delete it occaisionly. If this is the case, and you don't
  143. want to loose the Top CPS list from that text file, answer no. If you
  144. prefer that the CPS list is restarted every time, answer yes.
  145.  
  146. The next option is for the Top File lists. Because the file.data will
  147. usually be the largest, and most time consuming to scan, this option
  148. sets whether the file.data is always rescanned, or only when the active
  149. files has been changed (ie: uploading or deleting). If you answer yes,
  150. the data will always be rescanned. By answering no, the data is only
  151. rescanned when a file has been uploaded or deleted, this results in a
  152. faster update time, but less accuracy, as there may be several downloads
  153. that won't be detected until the data is rescanned.
  154.  
  155. As the message.data tends to be the largest file, you may elect not to
  156. use it at all if you wish, or you can use it, but not update it until
  157. the active messages has changed (see above).
  158.  
  159. All data is automaticly updated after a configuration.
  160.  
  161.  
  162. *Updating
  163. ---------------------------------------------------------------------------
  164. Maxi-Text stores all the 'Top Ten' data in the config file. To save a
  165. disk access time, it is only updated when you want it to be. You could
  166. do this every time in the logoff script, or only once a day. To do this
  167. use the following arguments -
  168.  
  169. Maxi-Text -r [using] [config]
  170.  
  171. Config is the name of the config file you wish to have updated, if you
  172. are using the default S:Maxi-Text.config, you may leave it blank. If
  173. you only use a pathname here, 'Maxi-Text.config' will be appended.
  174.  
  175. The update operation may take several minutes to complete, as all the
  176. user and file data must be scanned. If you have a cached cpu, the
  177. operation will only take around 2 minutes to complete, 68000 can take
  178. considerably longer.
  179.  
  180. You will need around 512K of free memory for every 10,000 files in the
  181. file.data, and the same goes for messages if you are using the
  182. functions. Memory may become fragmented after use, if it is bad under
  183. your system, run 'Sweep' after this program.
  184.  
  185. Maxi-Text also allows the use of a 'Last Users' list, this is not kept
  186. in the config file, as it will change constantly. The Log.Data will be
  187. read as neccasary. The other use of the 'Last Users' list is that you
  188. are not limited to 20 users, but as far you like. Or you can have a
  189. continuous list of the days users. See the insert docs for more
  190. information.
  191.  
  192.  
  193.  
  194.  
  195.  
  196. Notes:
  197.  
  198. 1.0 - First release, no bugs as yet....
  199.  
  200. 1.1 - Fixed bug where nulls were passed after strings. This version now also
  201.       handles directory scanning.
  202.  
  203. 1.2 - Sorry, Maxi-Text needed a larger stack size than default, now uses
  204.       extended stack code. Thanks to a sysop in the 'Gong for that one.
  205.  
  206. 2.0 - Redesigned the script language and added some new functions.
  207.  
  208. 2.1 - Improved the sorting function to avoid duplicate entries,
  209.       previously a user could have had his name more than once in the
  210.       top cps lists, this is now fixed and only their top rating is
  211.       kept. New list generation date functions added, thanks to Randy
  212.       Quick for that (I saw yours had them, so I thought I had better
  213.       put them in 8^) ).
  214.  
  215. 2.2 - Duplicate name bug definatly gone now !! All dates are now output
  216.       correctly and uses a new sort method that runs around 3 times
  217.       faster than before. Top CPS now allows duplicate names..
  218.  
  219. 2.3 - Removed Enforcer hits and updated some templates.
  220.  
  221. 2.4 - Innocent memory could be trashed on rare occaisions when the file
  222.       description was longer than 59 chars. Thanks to Steve Norton 8^)..
  223.       The 020+ version is back from this release..
  224.  
  225. I consider this program my best to date, so I will appreciate any bugs,
  226. big or small, and any ideas you have, as I would like to continue to
  227. update Maxi-Text. 
  228.  
  229.  
  230.          Thanks to Norbert Feist for Beta testing this program.
  231.  
  232.            Thanks to Steve Norton for Beta testing this program.
  233.  
  234.          For bug-reports and updates, call The Nut Factory BBS.
  235.  
  236.               V.22 V.22bis                  (02) 822-5613
  237.  
  238.  ! RingDown ! V.32 V.32bis V.42 V.42bis     (02) 822-4366 
  239.  
  240.               HST14.4K DS V.42 V.42bis      (02) 822-5329
  241.  
  242.